Fzzy Config/me.fzzyhmstrs.fzzy_config.validation/Shorthand/validated

validated

@JvmStatic

fun <E : Enum<E>> E.validated(): ValidatedEnum<E>

Shorthand validated Enum

Enum constant used will be the default

Return

ValidatedEnum wrapping the extended Enum constant

Author

fzzyhmstrs

Since

0.2.0

Parameters

the enum type. instanceof Enum and Translatable (me.fzzyhmstrs.fzzy_config.api.EnumTranslatable is recommended)

@JvmStatic

fun <E : Enum<*>> Class<E>.validated(): ValidatedEnum<E>

@JvmStatic

fun Identifier.validated(): ValidatedIdentifier

Shorthand validated Identifier

Boolean used will be the default

Return

ValidatedBoolean wrapping the boolean passed

Author

fzzyhmstrs

Since

0.2.0

@JvmStatic

fun Color.validated(transparent: Boolean = true): ValidatedColor

Shorthand validated Color

color values in the Color will be the defaults

Return

ValidatedColor wrapping the Color values passed. Note that the get() of the ValidatedColor does not return Color

Author

fzzyhmstrs

Since

0.2.0

Parameters

transparent

Boolean if this ValidatedColor accepts transparency values or not. Default false

@JvmStatic

fun <T : Any> List<T>.validated(handler: Entry<T, *>): ValidatedList<T>

Shorthand validated List

list used will be the default list

Return

ValidatedList wrapping the list and provided handler

Author

fzzyhmstrs

Since

0.2.0

Parameters

handler

Entry for handling the list values.

@JvmStatic

fun <T : Any> Set<T>.validated(handler: Entry<T, *>): ValidatedSet<T>

Shorthand validated Set

set used will be the default set

Return

ValidatedSet wrapping the set and provided handler

Author

fzzyhmstrs

Since

0.2.0

Parameters

handler

Entry for handling the set values.

@JvmStatic

inline fun <T : Number> List<T>.validated(): ValidatedList<T>

Shorthand validated number List

list used will be the default list. Automatically provides a default handler based on the type of Number provided

Return

ValidatedList wrapping the list

Author

fzzyhmstrs

Since

0.2.0

@JvmStatic

inline fun <T : Number> Set<T>.validated(): ValidatedSet<T>

Shorthand validated number Set

set used will be the default set. Automatically provides a default handler based on the type of Number provided

Return

ValidatedSet wrapping the set

Author

fzzyhmstrs

Since

0.2.0

@JvmStatic

fun <T : Any> TagKey<T>.~~validated~~(): ValidatedTagKey<T>

Deprecated

Use only for validation of a list or map.

Shorthand Validated TagKey, allowing any tag in the receiver tag's registry

Return

ValidatedTagKey wrapping the receiver as the default value

Author

fzzyhmstrs

Since

0.2.0